﻿// Sequin.Sequences.Mining.SequenceMinerResult
//
// (c) 2011 Arthur Pitman
//
// Part of the Sequin Library
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License (Version 2.1) as published by the Free Software Foundation.
// 
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
// 
// You should have received a copy of the GNU Lesser General Public
// License (Version 2.1) along with this library; if not, write to the 
// Free Software Foundation, Inc., 
// 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
// or see <http://www.gnu.org/licenses/>.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace Sequin.Sequences.Mining
{
	/// <summary>
	/// Stores the result of a mining process
	/// </summary>
	public class SequenceMinerResult
	{
		/// <summary>
		/// Indicates if the mining process was aborted
		/// </summary>
		public bool Aborted { get; set; }

		/// <summary>
		/// The time taken for the mining process
		/// </summary>
		public int TimeTaken { get; set; }

		/// <summary>
		/// The number of projections generated in the mining process
		/// </summary>
		public int ProjectionsGenerated { get; set; }

		/// <summary>
		/// The number of projections expanded in the mining process
		/// </summary>
		public int ProjectionsExpanded { get; set; }

		/// <summary>
		/// The number of patterns emitted in the mining process
		/// </summary>
		public int PatternsEmitted { get; set; }

		/// <summary>
		/// The patterns found in the mining process
		/// </summary>
		public List<SequentialPattern> Patterns { get; set; }

		/// <summary>
		/// Initializes a new <see cref="SequenceMinerResult"/> instance
		/// </summary>
		public SequenceMinerResult()
		{
			Patterns = new List<SequentialPattern>();
		}

	}
}
